example of a block comment

/** \brief Brief description of the function, a period is required after this description.
 * Full description of the function is placed here, it can span as many lines as needed.
 *
 * @param parameter_name Parameter desccription, may span several lines and is needed for each
 * 			 parameter.
 *
 * @param example_parameter This input is used as an example.
 *
 * @return Description of the return variable, this is not needed if there is no return
 * or if it is deemed not necessary.
 */


example of variable documentation, global variables only.

/**
 * Description of the variable.
 */
int variable_name